Object

Site

A representation of a website or web application that you want to scan and track using Burp Suite Enterprise Edition.

Fields

agent_pool(): AgentPool
The agent pool used for scanning this site.
api_definitions(): [ApiDefinition!]
The API definition.
application_logins(): ApplicationLogins!
All the saved application logins for this site. These can either be basic sets of login credentials or scripts of full login sequences that you recorded with the Burp Suite Navigation Recorder browser extension. These are used by scans to crawl areas of the site that are only accessible to registered users. Note that you can only use one type of application login for each site.
bchecks(): [BCheck!]
The bchecks assigned to this site.
email_recipients(): [EmailRecipient!]
A list of all the email addresses to which scan reports are sent whenever scans of this site finish.
ephemeral(): Boolean
In the 'Sites and scan data' settings, your Burp Suite Enterprise Edition administrator can configure the web UI to only display user-created sites in the site tree. In this case, all sites generated using the REST API will be set as 'ephemeral'. This means they will never be displayed in the site tree, even if the administrator changes this setting later.
extensions(): [Extension!]
The extensions assigned to this site.
id(): ID!
The unique identifier of the site.
name(): String
The name of the site. This is the name that appears on the Burp Suite Enterprise Edition web UI. Note that the name of a site must be unique within its parent folder.
parent_id(): ID!
The unique identifier of the folder that is the parent of this site in the site tree hierarchy. A parent ID of 0 indicates that this site is on the root level.
platform_authentication(): PlatformAuthentication!
Any platform authentication logins that have been saved against this site
scan_configurations(): [ScanConfiguration!]
A list of the scan configurations that you want to use for scans of this site.
scope_v2(): ScopeV2
The site scope.
settings(): SiteSettings
Settings that specify headers and cookies to use with the site.
slack_channels(): [SlackChannel]
The information about Slack notifications for this site.

Example

Query 
query GetSite($site_id: ID!) {
  site(id: $site_id) {
          id
      name
      parent_id
      ephemeral
      scope_v2 {
        start_urls
        in_scope_url_prefixes
        out_of_scope_url_prefixes
        protocol_options
      }
      scan_configurations {
        id
      }
      extensions {
        id
      }
      application_logins {
        login_credentials {
          id
          label
          username
          password
        }
        recorded_logins {
          id
          label
          script
        }
      }
      email_recipients {
        id
        email
      }
      agent_pool {
        id
        name
        agents {
          id
          name
        }
      }
      slack_channels {
        id
        name
      }
      settings {
          request_headers {
              id
              name
              value
              scope_prefix
          }
          request_cookies {
              id
              name
              value
              scope_prefix
          }
      }
  }
}
Result 
{
    "data": {
        "site": {
            "id": "20",
            "name": null,
            "parent_id": "0",
            "ephemeral": false,
            "scope_v2": {
                "start_urls": [],
                "in_scope_url_prefixes": [],
                "out_of_scope_url_prefixes": [],
                "protocol_options": null
            },
            "scan_configurations": [],
            "extensions": [],
            "application_logins": {
                "login_credentials": [],
                "recorded_logins": []
            },
            "email_recipients": [],
            "agent_pool": {
                "id": null,
                "name": null,
                "agents": []
            },
            "slack_channels": [],
            "settings": {
                "request_headers": [],
                "request_cookies": []
            }
        }
    }
}